Carvel Package Proposal #1678
Carvel Package Proposal #1678
Conversation
benjaminapetersen
force-pushed
the
ben/carvel-package-proposal
branch
from
4edb653 to
4eb9a3d
Compare
| - `Package` is a custom resource that represents configuration in the form of metadata and OCI images | ||
| that may be used to deliver software onto a Kuberentes cluster. See [the docs](https://carvel.dev/kapp-controller/docs/v0.47.x/packaging/#package) | ||
| for more information. | ||
| - `PackageMetadata` is a custom resource describing attributes for a `Package`. See [the docs](https://carvel.dev/kapp-controller/docs/v0.47.x/packaging/#package-metadata) |
There was a problem hiding this comment.
This looks like the way to specify your custom values.yaml, and thus cause your software to be installed. Does that sound correct?
There was a problem hiding this comment.
As a consumer, to install the software, you'll use a PackageInstall and a Secret, similar to this:
---
apiVersion: packaging.carvel.dev/v1alpha1
kind: PackageInstall
metadata:
name: "supervisor-package-install"
namespace: supervisor-install-namespace # should NOT be "supervisor", keep install stuff separate
spec:
serviceAccountName: "pinniped-package-rbac-supervisor" # will need RBAC
packageRef:
refName: "supervisor.pinniped.dev"
versionSelection:
constraints: ">0.25.0" # packages will auto upgrade if they can, up to this constraint
values:
- secretRef:
name: "supervisor-package-install-secret" # secret contains values.yaml values
---
apiVersion: v1
kind: Secret
metadata:
name: "supervisor-package-install-secret"
namespace: supervisor-install-namespace # should NOT be "supervisor", keep install stuff separate
# this looks familiar to us!
# this is where the actual values will live.
stringData:
values.yml: |
---
app_name: pinniped-supervisor
namespace: supervisor
api_group_suffix: pinniped.dev
image_repo: pinniped.local/test/build
image_tag: 6114CB3E-ACB5-4C67-ABE7-9ACC09B73056
log_level: debug
service_https_nodeport_port: 443
service_https_nodeport_nodeport: 31243
service_https_clusterip_port: 443
There was a problem hiding this comment.
could we add this to the example PackageInstall below?
There was a problem hiding this comment.
Yup, I can expand on this.
| `Supervisor` and `Concierge. For example: | ||
|
|
||
| ```yaml | ||
| spec: |
There was a problem hiding this comment.
Would you mind including apiVersion and kind on these example resources? Would really help me figure out how the pieces come together.
| No changes or additions to Pinniped's own APIs, this proposal represents a second, alternative | ||
| method for deployment utilising Carvel APIs and tools. | ||
|
|
||
| #### Upgrades |
There was a problem hiding this comment.
Could you include a note here about upgrading from a non-Carvel installation to a Carvel installation?
There was a problem hiding this comment.
I can. I think it would simply be backup your specific configuration, delete Pinniped & reinstall.
| @@ -0,0 +1,231 @@ | |||
| --- | |||
There was a problem hiding this comment.
Could we document which resources will not be deployed by the carvel package? Some possibilities:
- FederationDomain
- *IdentityProvider
- Ingress?
There was a problem hiding this comment.
Yeah that sounds good.
|
Per our last team discussion, this is going to remain POC and not a formally supported package. We will commit code, but push it down into the /lib directory. It will exist for reference purposes, but not with supported yamls and images published via releases. |
|
|
||
| ### Goals and Non-goals | ||
|
|
||
| Goals |
There was a problem hiding this comment.
At this point, should we update this section to indicate that this is not a fully supported feature and is instead meant to provide users both an example and a mechanism they may use to create their own package?
|
We have decided not to formally support Carvel packages for community usage at this time. There are some changes that have been merged in our Closing this. |
Related to: